home *** CD-ROM | disk | FTP | other *** search
/ A.C.E. 1 / ACE CD 1.iso / files / utils / musicx12.dms / in.adf / LookOut.doc < prev    next >
Encoding:
Text File  |  1988-08-07  |  4.2 KB  |  106 lines
  1.     LookOut - Music-X Librarian Protocol Monitor.
  2.     Music-X is a trademark of MicroIllusions.
  3.  
  4.     Written June 1988 by David Joiner a.k.a. Talin.
  5.     Another ElfTech product!
  6.  
  7.     Warning - the following material is for advanced users only!
  8.  
  9.     LookOut is a program which allows to to monitor the commincations
  10.     between the Music-X Librarian and the MIDI synthesizer. It is used
  11.     primarily for debugging new protocols. A window is displayed which
  12.     shows the various bytes transferred between Music-X and the
  13.     synthesizer.
  14.  
  15.     To Run LookOut, double-click on it's icon, or from the CLI type
  16.     'Run Lookout'. The LookOut window will open. Lookout may be quit
  17.     at any time by clicking on the close box in it's window.
  18.  
  19.     Using LookOut:
  20.  
  21.     During Library transfers, Music-X will print out various status
  22.     messages on the lookout window. An expanation of the various messages
  23.     is given below. 
  24.  
  25.     "Library Task Ready."
  26.         - this is printed at the start of Music-X.
  27.  
  28.     "** Send Patch **"
  29.         - this is printed at the start of a patch send.
  30.  
  31.     "** Receive Patch **"
  32.         - this is printed at the start of a patch receive.
  33.  
  34.     "Retrying..."
  35.         - an error was encountered during the transfer. The librarian will
  36.         attempt the transfer again. After 6 failed attempts, it gives up.
  37.  
  38.     "Data Remaining: XX"
  39.         - this is printed after a patch send. It indicates if there was
  40.         any data in that patch that didn't get sent. This usually indicates
  41.         a bug in the sending protocol.
  42.  
  43.     "Can't read zero bytes!"
  44.         - if a data field in the protocol specifies a length of zero
  45.         bytes, this message will be printed.
  46.  
  47.     "No Data Transmitted."
  48.         - similar to previous error, only occurs on a write rather
  49.         than a read.
  50.  
  51.     "Read Errors!"
  52.         - serial overrun errors on the MIDI port. Usually this means that
  53.         there are so many tasks in the Amiga that Music-X didn't have time
  54.         to capture a serial byte before the succeeding one came in, so a
  55.         byte was lost. Note that each disk drive has it's own task, as
  56.         well as each hard disk partition. (This is something that will be
  57.         addressed in future revisions of the Amiga operating system).
  58.  
  59.     "Device Error XX"
  60.         - indicates there was some kind of error with the MIDI.device.
  61.         Error    Meaning:
  62.         -2        data transfer was aborted.
  63.         -3        device received an unrecognized command.
  64.         -10       Device was not allocated
  65.  
  66.     "MIDI Unit Not Available."
  67.         - inidicates that some other task is using the MIDI.device.
  68.  
  69.     "ABORTED: Command Aborted..."
  70.         - indicates that the user canceled the library transfer.
  71.  
  72.     "ABORTED: Timeout..."
  73.         - occurs if the librarian is expecting data from the synth
  74.     and waits for more than 5 seconds without getting any.
  75.  
  76.     "Matching: [xx xx xx xx xx]"
  77.         - indicates that the bytes inside the brackets were received
  78.     from the synthesizer, and that they agree with the bytes that are
  79.     supposed to be received as specified by the protocol.
  80.         In addition, instead of hex bytes, there can be several other
  81.     things printed inside the brackets:
  82.         "(xx Normal Bytes)"
  83.             - indicates a number of normal data bytes were tranferred.
  84.         "(xx Nibbleized Bytes)"
  85.             - indicates a number of 'nibbleized' (i.e., each bytes
  86.             sent as two 4-bit packets) were transferred.
  87.         "(xx Packed Bytes)"
  88.             - indicates a number of 'packed' (i.e. bytes broken
  89.             up into 7-bit chunks) were tranferred.
  90.         "<Capture>"
  91.             - indicates that this protocol requires user intervention.
  92.             Timeout is disabled.
  93.         "(**xx)"
  94.             - indicates that a 'sentinel' code has been recognized.
  95.         "(Back xx)"
  96.             - only printed if a sentinel is used, indicates the number
  97.             of bytes between the sentinel and the previous data block.
  98.  
  99.     "Sending:  [xx xx xx xx xx]"
  100.         - indicates that the bytes inside the brackets were sent to the
  101.         synthesizer. - see previous item for special entries.
  102.  
  103.     "FAILURE - Expected [xx] Received [yy]"
  104.         - inidicates that the byte received from the synthesizer
  105.         did not match the value specified in the protocol.
  106.